*======================================*
* Readme - snYpir's SP/MP Support Pack *
*======================================*

The SP/MP (Single Player/Multiplayer) Support Pack aims to bring you everything you need for user-friendly artillery, air, close air, quick extraction and reinforcement support in your OFP missions. It does this through a central 'support request' dialog, and numerous other features that were introduced with OFP Resistance.

View the complete manual for the SP/MP Support Pack at http://www.ofpec.com/editors/mods/spt_pack/readme.html.

Requirements
------------

* OFP: Resistance version 1.90
* the SP/MP Spt Pack addon (SNYSptPack.pbo) available at http://www.ofpec.com/editors/spt_pack.php

What is in this zip?
--------------------

* SNYSptPack.pbo - the spt pack addon, to be copied to /Res/Addons on all computers (clients and server).
* changes.txt    - complete changelog from version 1.0 to now.
* readme.txt     - you are reading it

* examples\spt_pack_example.Eden
     - example mission showing off what the pack can do
     - requires the C130 addon if you want to do a paradrop (http://www.ofpec.com/editors/mods/spt_pack/addons/C-130_Hercules_V1.0a.zip)
* examples\spt_pack_example_advanced.Eden
     - shows how to use interface.sqs

* advanced\spt_pack_example_click_rappel.Eden
     - shows how to use interface.sqs to make single-click rappel
* advanced\spt_pack_example_click_rappel_MP.Eden
     - shows how to use interface.sqs to make single-click rappel in multiplayer
* advanced\spt_pack_sim_arty.Eden
     - shows how to define and use simulated artillery
     - requires the M198 addon (http://www.ofpec.com/editors/mods/spt_pack/addons/M-198.zip)

* templates\spt_pack_default.Intro
     - default spt pack template (to be merged, not played)
* templates\spt_pack_vietnam.Intro
     - vietnam spt pack template (to be merged, not played)
     - requires the F4 Phantom addon (http://www.ofpec.com/editors/mods/spt_pack/addons/F4.zip)

All example missions (not templates) are designed to be played in the mission editor.

In-Game useage (quick start)
----------------------------

Extract the spt pack zip to a folder on your hard drive (preserve folder structure). Copy SNYSptPack.pbo to your /Res/Addons folder in your OFP directory. Copy examples\spt_pack_example.eden to your /Users/(your username)/Missions directory.

Load the example mission (spt_pack_example.eden) in the editor and preview it. You'll notice the 'Request Support' radio channel. There are two ways to designate a target for a mission:

1. Via single click on the map. Go to the map screen, click on the radio channel, and then click on the map where you want the support.

2. With a laser designator. Pick up the laser designator and ammo from the ammo box at the start of the mission. Ready the laser designator, point to where you want the support and hit the fire button to begin designating. Then use the keyboard to access the radio channel to call the support. Once you have pressed 'Submit' on the dialog, there is no requirement to keep designating the target.

The fire support request dialog is fairly self-explanatory. Select a battery/airbase, and then select a specific mission. You can set the duration of support. Note that for close air support, the duration commences from when the aircraft arrive in the target loc.

You can also set the starting time of the support if you wish.

If you have previously submitted requests that are pending, you can see them in the drop down box at the bottom of the dialog. You can click on the '>' button to view where on the map the support was targeted. You can also delete pending requests.

Once you are happy with your settings, hit 'Submit' to radio the fire controller or 'Cancel' to escape.

Bear in mind that the list of available support in the dialog is dynamic. If certain support types are not valid in the location that you targeted, they will not be visible in the dialog.

Try targetting Saint Pierre with 105mm shells. You'll notice that you won't be allowed to launch an artillery strike there, because a no fire zone has been defined over that area in the editor.

All missions are 'fire and forget', except for a helo extraction. If you call for a helo extraction, choppers will move from their base to the targeted location. They will wait at the LZ for a period of time, and then return back to the base (or to the alternate drop-off position if cargo has boarded and the alternate position has been previously defined by the mission editor).

If you board the chopper whilst it is on the ground, you can order it to take off immediately by using the radio.

Installation
------------

These instructions tell you how to merge the support pack into a new or existing mission.

The support pack is contained in a single addon: 'SNYSptPack.pbo'. Once you have downloaded the support pack zip to your harddrive, follow the following steps to integrate the pack into your mission:

* Extract the contents of the zip you downloaded to somewhere on your harddrive.

* Copy 'SNYSptPack.pbo' into your OFP installation's /Res/Addons folder. It also needs to be installed on any client computers in a MP environment.

* Copy the mission folders into your OFP installation's /Users/(your name)/Missions folder.

* (Skip this step if you already have an init.sqs file) In your mission's folder, right click on the background of the window in Windows, and select New -> Text Document. Name the new file 'init.sqs'.

* Open the 'init.sqs' file in notepad (or some other text editor), and place the following at the top:

[] exec "\SNYSptPack\init.sqs"

* (Skip this step if you already have a description.ext file) In your mission's folder, right click on the background of the window in Windows, and select New -> Text Document. Name the new file 'description.ext'.

* Open the 'description.ext' file in notepad (or some other text editor), and place the following at the top:

#include <SNYSptPack\dialogs.h>

* Choose a template mission (one of the mission folders you copied previously).

* Copy the 'SNYSptPack' folder out of your chosen template mission folder and into your mission.

* Start OFP, and open your mission in the editor.

* Merge the template mission with your mission by hitting the 'merge' button.

* Move the support markers around to place the support. See configuration below for more information.

New versions of the support pack will be compatible with old missions! Simply install the new addon.

Upgrading your missions
-----------------------

New versions of the support pack come with new capabilities. All old missions will work with new versions of the pack. Simply download and install the new SNYSptPack.pbo addon.

However, some changes are required to use new features.

* New settings (most new versions will come with new settings)

As new versions come out, additional settings will be available in the init_general.sqs file. Check out the new settings by downloading the Spt Pack and viewing the init_general.sqs file of one of the example missions, or view the revision history.

Simply copy the new settings as required. You don't have to copy every new setting; if the spt pack can't find a particular setting, the default setting will be used.

* Activating init_reinforce.sqs (required from version 1.29)

To activate reinforcements, you need to instruct the pack to load your init_reinforce.sqs script in your init_general.sqs file. Copy the following into your init_general.sqs file to make sure ALL init files are loaded:

sny_arty_var_load_init_artillery_sqs = true
sny_arty_var_load_init_closeair_sqs = true
sny_arty_var_load_init_airstrike_sqs = true
sny_arty_var_load_init_extraction_sqs = true
sny_arty_var_load_init_reinforce_sqs = true

* Specifying rappel position to interface.sqs (required from version 1.29)

Rappelling via interface.sqs now requires more parameters. You need to specify where you want to rappel, otherwise the rappel will occur wherever the script was called. See the online manual (accessing chopper land and rappel scripts in-game) for more information.

Configuration
-------------

Configuration of the Support Pack involves two steps; in-editor configuration and file configuration. You do not need to do any file configuration if you don't want to, but the init files are easily used to customise the available support.

-> In-editor Configuration

You must have the following in your mission for the pack to work:

* A game logic unit named 'Server'
* A radio trigger for each side that can call fire support (a maximum of 4)
* An additional radio trigger that will be used when boarding extraction choppers.
* A marker of any type, named 'mTarget'.
* A trigger, named 'detectlaser', that is as big as the whole map and fires repeatedly at a frequency of 1 second
* A whole heap of markers of type ellipse - solid (at least 20), named mr1 - mr20.

All of the above will be included automatically if you have merged or used a template (recommended).

In addition, the following is required:

* Markers (can be of any type) that represent each battery/airbase that will be available in the game (required).

- All you have to do is move the markers to where you want the respective batteries/airbases in your mission. If you don't want a particular support type to be included in your mission, you can simply delete the marker for that support type in the editor.
- If a defined battery/airbase does not have a marker in the editor, it will not be available in-game.

* No fire zone triggers. No fire zones are areas that arty/airstrikes are not allowed to fire into. These might be friendly bases or villages with civilians. A no fire zone trigger needs to have:

- A name (this name goes into the init files)
- Be set to trigger repeatedly on game logic
- You can make the trigger any shape or size.
- No fire zones are 'plugged in' to definitions in the init files.

-> File configuration

The following files reside in the 'SNYSptPack' folder you copied from a template into your mission:

* init_general.sqs
* init_artillery.sqs
* init_airstrike.sqs
* init_closeair.sqs
* init_extraction.sqs
* init_reinforce.sqs

I have tried to make the system as powerful as possible, but still reasonably simple to modify things to suit your own needs. The init files are full of comments detailing how to modify the various settings and support configurations.

Both airbourne and artillery support work on the following principle:

fire mission details + a location to launch the fire mission from = an available fire mission

See the comments in each init file for further information.

License Agreement
-----------------

The SP/MP Support Pack for the purpose of this license agreement is considered to be the SNYSptPack.pbo addon and any scripts, objects and textures within, and any related content accessable from http://www.ofpec.com/editors/spt_pack.php. The author is snYpir (morpj97@hn.ozemail.com.au).

The SP/MP Support Pack may not be modified and redistributed, or redistrubted via any other location other than the Operation Flashpoint Editing Center (OFPEC) without the author's express permission. The SP/MP Support Pack is freeware, and no part of the addon nor any mission requiring the addon may be sold without the permission of the author.

No part of the SNYSptPack.pbo addon may be used in any other addon without the permission of the author.

The SNYSptPack.pbo addon may be bundled with missions created by third parties, and hosted by other sites, providing the addon remains in the same package as the mission and the mission is not sold.

The author claims no responsibility for any damage or otherwise undesired outcome that the SP/MP Support Pack may cause, and offers no additional assistance on using the resource. The author does not guarantee that the SP/MP Support Pack will work as expected. You use the SP/MP Support Pack at your own risk.

Help!
-----

The online documentation is available at http://www.ofpec.com/editors/mods/spt_pack/readme.html.

Please use the OFPEC forum if you have questions on using the SP/MP Support Pack. The following thread is recommended:

http://www.ofpec.com/yabbse/index.php?board=27;action=display;threadid=6022

Credits
-------

* CoC Mod (inspiration and some marker code, also CoC_Mines addon from which parts have been integrated into SNYSptPack.pbo)
* bn880 (original MP arty code)
* Skumball (for his airstrike script)
* joltan (beta tester)
* Black Dog
* Toadlife (cheers for the use of your server dude!)
* Doolittle (ideas man)
* Dinger (for showing me how to create MP shrapnel with CoC_Mines)
* Vektorboson (dust effects)
* TJ (different dust effects)
* Zayfod (rappel scripts)
* Shogun for the napalm (integrated into SNYSptPack.pbo)
* Phaeden for the USMC markers addon (enhanced by Spinor to 1.2, and integrated into SNYSptPack.pbo)
* OFPman1 and Remo for the F4 Phantom addon
* HawkfighterJP for the rope and rappelling anim
* DutchBoY for the scud scripts
* Dschulle for the bank/pitch functions
* Rastavovich for the CCIP script
* Jahave for texturing the rope

snYpir
22 Apr 03

morpj97@hn.ozemail.com.au